home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / tag_bbs / tfm122.zip / TURBOFM.DOC < prev    next >
Text File  |  1992-08-09  |  22KB  |  453 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.      TTTTTTTT  UU   UU  RRRRRRR   BBBBBBB    OOOOO   FFFFFF  MM      MM
  24.         TT     UU   UU  RR    RR  BB    BB  OO   OO  FF      MMM    MMM
  25.         TT     UU   UU  RR    RR  BB    BB  OO   OO  FF      MM M  M MM
  26.         TT     UU   UU  RRRRRRR   BBBBBBB   OO   OO  FFFF    MM  MM  MM
  27.         TT     UU   UU  RR    RR  BB    BB  OO   OO  FF      MM      MM
  28.         TT     UU   UU  RR    RR  BB    BB  OO   OO  FF      MM      MM
  29.         TT      UUUUU   RR    RR  BBBBBBB    OOOOO   FF      MM      MM
  30.  
  31.         
  32.         T U R B O  F I L E  M A N A G E R   V 1.21  F O R  T A G  B B S
  33.  
  34.            Copyright(C) 1992  -  Royale Software, All rights reserved.
  35.                 Written by: Mike Normand for TAG 2.6 and Higher
  36.  
  37.  
  38.  
  39.  
  40.  
  41.                                Table of Contents:
  42.                                ------------------
  43.  
  44.     Chapter Description                                          - Page -
  45.  
  46.     ---------------------------------------------------------------------
  47.     Packing List .................................................. 1
  48.     About Turbo File Manager ...................................... 1
  49.     Credits ....................................................... 1
  50.     Warranty ...................................................... 2
  51.     License Agreement and Copyright ............................... 2
  52.     System Requirements ........................................... 2
  53.     Support Information ........................................... 2
  54.     Setup Instructions ............................................ 3
  55.     Using TurboFM ................................................. 4
  56.     The Move Command .............................................. 5
  57.     The Offline Command ........................................... 6
  58.     The Remove Command ............................................ 6
  59.     The Delete Command ............................................ 6
  60.     The Erase Command ............................................. 6
  61.     Log Functions ................................................. 6
  62.     Multi-Node Concerns ........................................... 7
  63.     Registration Information ...................................... 8
  64.     BBS Support Site .............................................. 8
  65.  
  66.  
  67.  
  68.    Turbo File Manager                                           - Page 1 -
  69.  
  70.     Packing List:
  71.     -------------
  72.     The following files should be included in this archive.
  73.    
  74.     ----------------------------------------------------------------------
  75.     TURBOFM .DOC      22349   08-08-92   TurboFM Main Documentation
  76.     TURBOFM .EXE      32488   08-08-92   TurboFM Main Program
  77.     SETUP121.EXE       5609   08-08-92   TurboFM Configuration Program
  78.     REGISTER.TXT       1323   08-08-92   Registration Information
  79.     ERROR   .LST        913   08-08-92   Program Error Codes
  80.     100-121 .DOC       1356   08-08-92   Conversion from 1.0(a) to 1.21
  81.     WHATSNEW.121        938   08-08-92   Changes from the previous version
  82.     ----------------------------------------------------------------------
  83.  
  84.     About Turbo File Manager:
  85.     -------------------------
  86.     The Turbo File Manager Program was designed to make the life of a
  87.     sysop/co-sysop easier.  Every aspect of the program has been geared
  88.     towards making an active file system an easy task to manage. This
  89.     documentation is an explanation of this program alone.  If you do not
  90.     know how to use the TAG files system or the TAG menu system then you
  91.     will need to read the TAG manual regarding those features before
  92.     installing this program.
  93.  
  94.     Like so many other utilities, TurboFM evolved to fill a definate need of
  95.     the Tag BBS sysop.  After hearing other sysops request a simple and more
  96.     effective way of moving files around while logged on to the bbs, the
  97.     first beta of TurboFM was developed....from there many modifications have
  98.     been made to the program which have helped it to become one of the best
  99.     ways to manage your BBS files section area.
  100.  
  101.     What this program does is make the files system in TAG much easier to
  102.     manage.  It adds needed commands to the Tag File system that allow you
  103.     to Move, Delete, Offline, Remove and Erase files using wildcards.  Best
  104.     of all TurboFM is a FAST program.  It was one of the biggest concerns to
  105.     make a program that not only worked well, but one that didn't need input
  106.     from the user at every step of the way.  Many other programs do the same
  107.     type of things as TurboFM, but unfortunately you were not able to use
  108.     them while logged onto the BBS and none of them worked from a Remote
  109.     location while logged onto the system.  Worse yet, some of the programs
  110.     were outdated with the new editions and new features of the BBS software.
  111.  
  112.     TurboFM is compatible with all of the new features of Tag 2.6c, such as
  113.     placing the *.dir files in the Gfiles directory (MultiNode Dir too), and
  114.     as the sysop you can restrict access to some of the functions of the
  115.     program.  In other words, you could give your co-sysops access to move
  116.     files but not the access to delete them.  But best of all, this program
  117.     works exactly like the TAG system that you are already familiar with, and
  118.     you don't have to exit the BBS in order for it to run.
  119.     
  120.     Credits:
  121.     --------
  122.     Before going any further, thanks go out to all the people that help with
  123.     the programming of the TAG BBS software.  They have given us a wonderful
  124.     program to use.  The *BETA* testers of TurboFM should also deserve to be
  125.     thanked for all of thier help and suggestions.
  126.  
  127.  
  128.  
  129.     Turbo File Manager                                          - Page 2 -
  130.  
  131.     Warranty
  132.     --------
  133.     No warranty is expressed or implied.  Use this software at your own
  134.     risk.  The author of TurboFM can not be held responsible for the use
  135.     or misuse of this software.  Please read the documentation carefully
  136.     before setting up this program on your BBS.
  137.  
  138.     License Agreement and Copyright
  139.     -------------------------------
  140.     You may freely evaluate this program during the evaluation period as
  141.     set by the programmer in each release version.  The current version
  142.     will function until Sep. 16, 1992.  If you have not registered the
  143.     program by this date the program will discontinue working.
  144.  
  145.     This program may be freely distributed so long as all the original
  146.     files are left unmodified, no files have been added or removed from
  147.     the original archive, and no fee is charged.
  148.  
  149.     TurboFM is not, and never has been, Public Domain, it is copyrighted
  150.     1992, by Royale Software and Mike Normand.
  151.  
  152.     System Requirements
  153.     -------------------
  154.     Basically if you have TAG working on your system then TurboFM will work.
  155.     TurboFM reads the STATUS.DAT file from the directory that it is dropped
  156.     to when execute the program from a batch file.  If the Status.Dat file
  157.     cannot be found in this directory then the program will not work.
  158.  
  159.     This software has been tested to run fine using various versions of DOS
  160.     and using hardware from a 286 to a 486.  If you are having problems with
  161.     the program and you feel that it is not your own error then please
  162.     contact me so that I may make any necessary changes.
  163.  
  164.     Support Information
  165.     -------------------
  166.     If you need to contact the author regarding any problems or questions
  167.     with this program, then he may be reached at Castle Royale BBS in
  168.     Allen Park, MI.  Phone 313-382-3996 or Node 1:120/359 on the FidoNet
  169.     system. A Royale Software Support Echo is available for those who are
  170.     interested in knowing the latest news and information regarding any of
  171.     Royale Software's newest TAG BBS utilities.  The Echo Tag name is
  172.     ROYALE_SOFTWARE.  If this Echo is not available in your area then it may
  173.     be picked up from Castle Royale 24 hours a day, providing that prior
  174.     arrangements have been made.  For your convenience, this information will
  175.     be repeated at the end of this file.
  176.  
  177.  
  178.     Turbo File Manager                                          - Page 3 -
  179.  
  180.     Setup Information
  181.     -----------------
  182.     TurboFM is a very easy program to setup on your BBS system.  You will
  183.     need to make a directory off of the Main BBS directory and name it
  184.     TURBOFM.  Place the TurboFM.EXE directory (ex C:\BBS\TURBOFM).  Then
  185.     place the SETUPxxx.exe program in the directory that contains the
  186.     Status.Dat file.  Now run the SETUPxxx.EXE program and the TURBOFM.CFG
  187.     for this Node will be created for you along with 5 Batch files. The
  188.     created files are set up to run TurboFM in a directory named TURBOFM
  189.     located off of the main BBS directory, if you chose to run the program
  190.     from any other directory you will have to edit the Batch files so that
  191.     they choose the correct directory.  (Multi Node BBS User see the Multi
  192.     Node section at the end of this text)
  193.  
  194.     Now that all of the DOS based setup has been done you will need to load
  195.     up TAG and make the actual commands on the File System Menu which will
  196.     start the program.
  197.  
  198.     Go into the Tag Menu Editor for the Files area and make five new menu
  199.     commands.  You will then need to edit the commands so that they contain
  200.     the correct information for each of the five functions of the program.
  201.     You can set the access levels and flags as you see fit, but the Pkey and
  202.     Pdata must be entered correctly.  Here is an example to follow:
  203.  
  204.     Command number      : 41
  205.     1. Long desc.       : TurboFM Move Command
  206.     2. Short desc.      : (/TM)Turbo Move
  207.     3. Key              : /TM
  208.     4. General SL       : 150
  209.     5. AR flag          : S
  210.     6. Program Key      : H
  211.     7. Program Data     : "$?!OPTION-M"
  212.     F. Flags            : SL access, GSL and AR, Normal, No Linking
  213.  
  214.     Just repeat this format for the other 4 commands, using the different
  215.     options (-E,-O,-R,-D).  Make sure that you have the $?! part of the
  216.     command in the correct order.  Tag does not like that command segment
  217.     to be out of order.
  218.  
  219.     With this done, TurboFM is setup!
  220.  
  221.     NOTE:  It is not necessary to use all five of the commands of the
  222.     program.  TurboFM was made specifically so that you, as sysop of the
  223.     BBS, could determine which commands you wanted to use, and also
  224.     determine what access to give the commands.
  225.  
  226.  
  227.  
  228.     Turbo File Manager                                          - Page 4 -
  229.  
  230.     Using TurboFM
  231.     -------------
  232.     Using TurboFM is very simple.  Once you have the commands setup on your
  233.     system you simply need to type the key that starts that command. Once you
  234.     have used the program a couple of times it becomes second nature.  This
  235.     is because every effort was made to keep the same feel that you are
  236.     already used to.
  237.     Typing the command /TM (Turbo Move) will produce a statement from Tag
  238.     that tells you that 'Wildcards accepted' and then it will prompt you for
  239.     the name of a file.  You must then enter the name of a file that is in
  240.     the directory area that you are currently in.  This is no different than
  241.     the regular Tag program, meaning that if you want to move files from area
  242.     3 to area 7 you must be in area 3 and the file that you want to move must
  243.     be located in area 3.
  244.  
  245.     The filename that you type in at the prompt is then passed to the
  246.     program when it loads.  For example, if you want to move all the files
  247.     that match TAG?????.ZIP you could just enter TAG*.ZIP and the program
  248.     would then know that it was working with those files.
  249.  
  250.     If you type in the name of a file that does not appear in the area that
  251.     you are in you will be returned to the menu prompt.  You can use any
  252.     combination of asterick (*) or question mark (?) wild card characters to
  253.     activate the program, even things like *.* are acceptable.
  254.     
  255.     Now that you have an idea of how to setup and operate the program, lets
  256.     examine how the various commands of the program operate in a little
  257.     more detail.
  258.  
  259.  
  260.     Turbo File Manager                                          - Page 5 -
  261.  
  262.     The Move Command
  263.     ----------------
  264.     The TurboFM Move command is the fastest way to move files from one area
  265.     of the BBS to another area.  It uses some advanced logic so that it is
  266.     able to move the files using the least amount of work, and since wild
  267.     cards are accepted, it is not necessary to reply to a prompt for each
  268.     single file move.
  269.  
  270.     Upon invoking the Move command you will be shown the list of files that
  271.     match the filename that you entered.  If the files shown are the ones
  272.     that you want to move then you only need to tell the program what area
  273.     to move them to and it will do the rest for you.
  274.  
  275.     Should you forget the area number that you want to move the files into
  276.     you can use the ? command and get a listing of all the file areas.
  277.     (SYSOP NOTE: Users on the system are only shown the file areas that they
  278.     have access to....so TurboFM works just like TAG in that it uses dynamic
  279.     numbering, and it allows you to preserve the access of restricted areas).
  280.  
  281.     Once you enter the area to move the files to, TurboFM takes over and
  282.     moves all the selected files into that area.  You are not required to
  283.     reconfirm that you want to move the files again and again, the program
  284.     just moves them.  Please note that it moves all the files that are
  285.     selected.  So if you only want to move a few files make sure that you
  286.     give the progam the correct file name so that it will only select the
  287.     ones that you actually want moved.
  288.  
  289.     If the move request that you are making required TurboFM to move files
  290.     from one drive to another (ie C: to D:) then the program will use the
  291.     filesize from the Tag *.dir file to determine if the selected files
  292.     will fit on the Target drive.  If the files will fit they are moved
  293.     automatically, however if there is a size problem you will be warned
  294.     and asked if you want to proceed with the move.
  295.  
  296.     The reason behind asking if you wish to proceed comes from the fact that
  297.     many sysops have thier files offline, but the Tag *.dir files still
  298.     show the files as if they were actual size.  In order to make the program
  299.     work faster, it reads the file sizes from the Tag file listings rather
  300.     than from the actual disk drives.
  301.  
  302.     Also along those same lines, if the file sizes of the selected files as
  303.     read from the *.dir file total up to 0 blocks, then those files are
  304.     assumed to be offline and no effort is made to move the file, only the
  305.     directory listing is moved to the new area.
  306.  
  307.     As an added feature of the program, whenever you move files, the Target
  308.     area is then sorted into Name/Ascending order.  In future versions of
  309.     the program sorting may be optional, and it may also include the ability
  310.     to select the method of the sort.
  311.  
  312.     For safety sake, (memory wise that is) TurboFM does not attempt to sort
  313.     an area that has more than 2000 files.  If you happen to have one single
  314.     *.dir file that has more than 2000 files, I would seriously recommend
  315.     that you split it up into smaller and more manageable sizes.
  316.  
  317.  
  318.     Turbo File Manager                                          - Page 6 -
  319.  
  320.     The Offline Command
  321.     -------------------
  322.     This command allows you to mark the selected files as OFFLINE.  This is
  323.     done by setting the blocks file size to zero.  Again the wild card
  324.     characters may be used to select multiple files.  This is a nice feature
  325.     of the program, because most utils that are currently available only
  326.     allow you to Offline all the files in one dir file.  This program will
  327.     allow you to be more selective.
  328.  
  329.     The Remove Command
  330.     ------------------
  331.     This command takes the selected files and removes thier listings from
  332.     the *.dir file.  The files on the Hard Drives are not touched and will
  333.     remain intact.  You are asked to confirm this action before it is
  334.     performed.
  335.  
  336.     The Delete Command
  337.     ------------------
  338.     This command is the exact opposite of the previous command.  This one
  339.     allows you to delete the selected files from the Hard Drive, while
  340.     leaving the directory information intact.  This is useful if you are
  341.     planning to make files offline.  However, the block size of the files
  342.     is left at its current value, so if you prefer to leave the file sizes
  343.     intact you will be able to do so.  You are asked to confirm this action
  344.     before it is performed.
  345.  
  346.     The Erase Command
  347.     -----------------
  348.     This command is nothing more than the previous two commands combined.
  349.     The selected files are deleted from the Hard Drive and thier directory
  350.     info is also removed.  As usual, you are requested to confirm this
  351.     action before it is performed.
  352.  
  353.     Log Functions
  354.     -------------
  355.     It is possible to log all of the actions of the program.  In order to
  356.     turn this option on you only need to add a /L onto the end of the
  357.     command line that is loading the TurboFM program.  By making the Log
  358.     file optional it is possible to log file moves, but to opt not to log
  359.     file deletions, or vice-versa.  The included batch files all have the
  360.     log file option turned on, so if you do not want the program to log its
  361.     work then you will have to edit the batch files to remove the /L switch.
  362.  
  363.     In registered versions of the program you can choose the path and
  364.     file name of the log file that you wish to use for the program.  Simply
  365.     enter the path and filename of the log file in the TurboFM.cfg file on
  366.     the third line of that file.  If the file that you choose does not exist
  367.     then it will be made for you.  Unregistered versions log file will be the
  368.     sysop.log regardless of the information contained in the TurboFM.cfg
  369.     file.
  370.  
  371.  
  372.     Turbo File Manager                                          - Page 7 -
  373.  
  374.     Multi-Node Concerns
  375.     -------------------
  376.     With the release of Tag 2.6c and 2.6c1 there is now a multi-node version
  377.     of this software, and with that come some interesting programming
  378.     situations.  Since the majority of the BBS systems are still running a
  379.     single node, it was felt that it would be better to release this program
  380.     now, rather than waiting until I had the multinode version finished.
  381.     This program is aware of *.dir files that are located in the Multi-Node
  382.     directory, so it will work on a multi-node system, but no work has been
  383.     done to make this a 'Share Aware' program and therefore it is recommended
  384.     that you only use this program while there are no other users online.
  385.  
  386.     Provisions are being made to have a fully multi-node compatible version
  387.     of this program available soon.  Everyone should be reminded that it took
  388.     the Tag Team about a year to make Tag multi line, so dont get too
  389.     frustrated if a month or two is needed to make the program work the way
  390.     it should under a multi user system.
  391.  
  392.     Single line BBS systems can use this program 100%!
  393.  
  394.     To run the program on a Multi-User system you need to have one
  395.     TURBOFM.CFG file for every node that you have.  Each config file must
  396.     exist in the same directory as the Status.Dat file for that node.
  397.     (I am not sure if you have to have batch files for each node at this
  398.     point, but they are only about 55 bytes each so if you duplicate them
  399.     it wouldn't be a bad idea)
  400.  
  401.     TurboFM works the same way as Tag in that it will search for the User.lst
  402.     and the Fboards.dat files in the Gfiles directory, and if they cannot be
  403.     found in that area then they will be looked for in the Multi Node dir.
  404.     If they still cannot be found then the program will abort.
  405.  
  406.     Care must be taken not to use the program while users are on line due
  407.     to the fact that there are many things that can be done to conflict
  408.     between the nodes.  TurboFM only READS the Status.Dat file, User.Lst,
  409.     and Fboards.Dat files.  They are not written to in any way, so the
  410.     likely hood of something bad happening to them is remote.  However, the
  411.     *.dir files are heavily manipulated and unforseen things can happen if
  412.     two people try to access the same file at the same time.
  413.     Suffice to say that you have been warned....a fully compatible Share
  414.     Aware version is in the works...just be carefull with this one until
  415.     that one is completely finished.
  416.  
  417.     Again...Single Node systems may use the Program 100%
  418.  
  419.  
  420.  
  421.     Turbo File Manager                                          - Page 8 -
  422.  
  423.     Registration Information
  424.     ------------------------
  425.     Registration for this program is only $10.00.  When you are ready to
  426.     register this program then you will need to send a check or money order
  427.     to the author for that amount.  Include with it the name of your BBS
  428.     system, exactly as it appears in the Status.Dat file.  Also include
  429.     either your mailing address, or a Fido Net Node number to which an
  430.     updated config file can be sent.  If you provide a Fido Net Node number,
  431.     the author will pay for the phone call to send you the new config file.
  432.  
  433.     Send your check or money order payable to Mike Normand to:
  434.  
  435.     Mike Normand  P.O. Box 164  Allen Park, MI  48101
  436.  
  437.     BBS Support Site
  438.     ----------------
  439.     Thats all there is to say regarding this utility program.  If you have
  440.     any bugs to report, or if you have any suggestions for the program then
  441.     you can contact the support BBS.
  442.  
  443.                    Castle Royale
  444.                      Allen Park, MI - (313) 382-3996
  445.                        US Robotics 16.8 Dual Standard Modem
  446.                          2400 - 16800 bps - 24 Hrs / 7 Days
  447.                            FidoNet Address - 1:120/359
  448.  
  449.     If you are interested in picking up the Royale_Software support echo
  450.     then send a Net Mail message and it will be turned on for you.
  451.  
  452.     Enjoy the program!
  453.